支付渠道 extra 参数说明
特定渠道发起交易时需要的额外参数,以及部分渠道支付成功返回的额外参数。cp_b2b
渠道不需要 extra
参数。
alipay(支付宝 App 支付)
extra 参数 | 说明 |
---|
hb_fq_num optional,int | 仅适用于支付宝 openapi 接口,hb_fq_num 和 hb_fq_seller_percent 必须同时传入有效。使用花呗分期要进行的分期数,必须根据支付宝签约的分期数填写,可选值:3、6、12。 |
hb_fq_seller_percent optional,int | 仅适用于支付宝 openapi 接口,hb_fq_num 和 hb_fq_seller_percent 必须同时传入有效。使用花呗分期需要卖家承担的手续费比例的百分值,传入100代表100%,可选值:0、100。 |
disable_pay_channels optional,string | 仅适用于支付宝 openapi 接口。禁用支付渠道,用户不可用禁用的渠道支付,当有多个付款渠道需禁用时,用,分隔(如moneyFund,credit_group),可禁用的支付渠道相关值参考下方 disable_pay_channels 参数说明 。 |
sys_service_provider_id optional,string | 仅适用于支付宝 openapi 接口。系统商编号,该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的 PID。 |
need_buyer_real_named optional,string | 适用于支付宝 openapi 接口。是否发起实名校验,T 代表发起实名校验;F 代表不发起实名校验。 |
extern_token optional, string | 仅适用于支付宝 mapi 接口。开放平台返回的包含账户信息的 token(授权令牌,商户在一定时间内对支付宝某些服务的访问权限)。通过授权登录后获取的 alipay_open_id ,作为该参数的 value ,登录授权账户即会为支付账户,32 位字符串。 |
rn_check optional,string | 适用于支付宝 mapi 接口。是否发起实名校验,T 代表发起实名校验;F 代表不发起实名校验。 |
buyer_account response-only,string | 适用于支付宝 openapi 接口。支付完成将额外返回付款用户的支付宝账号。 |
fund_bill_list response-only,array | 适用于支付宝 openapi 接口。交易支付使用的资金渠道,详见下方的 fund_bill_list 渠道透传返回 。 |
buyer_user_id response-only,string | 适用于支付宝 openapi 接口。买家在支付宝的用户 id 。 |
voucher_detail_list response-only,array | 适用于支付宝 openapi 接口。本交易支付时使用的所有优惠券信息,详见下方的 voucher_detail_list 渠道透传返回 。 |
is_absolute_time optional,boolean | 是否使用绝对超时时间,如 true,time_expire 参数为绝对时间。 |
disable_pay_channels 参数说明
extra 参数 | 说明 |
---|
balance | 余额 |
moneyFund | 余额宝 |
coupon | 红包 |
pcredit | 花呗 |
pcreditpayInstallment | 花呗分期 |
creditCard | 信用卡 |
creditCardExpress | 信用卡快捷 |
creditCardCartoon | 信用卡卡通 |
credit_group | 信用支付类型(包含信用卡卡通、信用卡快捷、花呗、花呗分期) |
debitCardExpress | 借记卡快捷 |
mcard | 商户预存卡 |
pcard | 个人预存卡 |
promotion | 优惠(包含实时优惠+商户优惠) |
voucher | 营销券 |
point | 积分 |
mdiscount | 商户优惠 |
bankPay | 网银 |
fund_bill_list 渠道返回参数
extra 参数 | 说明 |
---|
fund_channel response-only,string | 仅适用于支付宝 openapi 接口。交易使用的资金渠道,详见 alipay 支付渠道列表 。 |
amount response-only,string | 仅适用于支付宝 openapi 接口。该支付工具类型所使用的金额。 |
real_amount response-only,string | 仅适用于支付宝 openapi 接口。渠道实际付款金额。 |
alipay 支付渠道列表
extra 参数 | 说明 |
---|
COUPON | 支付宝红包 |
ALIPAYACCOUNT | 支付宝账户 |
POINT | 集分宝 |
DISCOUNT | 折扣券 |
PCARD | 预付卡 |
MCARD | 商家储值卡 |
MDISCOUNT | 商户优惠券 |
MCOUPON | 商户红包 |
PCREDIT | 蚂蚁花呗 |
voucher_detail_list 渠道返回参数
extra 参数 | 说明 |
---|
id response-only,string | 仅适用于支付宝 openapi 接口。券 id。 |
name response-only,string | 仅适用于支付宝 openapi 接口。券名称。 |
type response-only,string | 仅适用于支付宝 openapi 接口。当前有三种类型: ALIPAY_FIX_VOUCHER - 全场代金券、ALIPAY_DISCOUNT_VOUCHER - 折扣券、ALIPAY_ITEM_VOUCHER - 单品优惠。注:不排除将来新增其他类型的可能,商家接入时注意兼容性避免硬编码。 |
amount response-only,string | 仅适用于支付宝 openapi 接口。优惠券面额,它应该会等于商家出资加上其他出资方出资。 |
merchant_contribute response-only,string | 仅适用于支付宝 openapi 接口。商家出资(特指发起交易的商家出资金额)。 |
other_contribute response-only,string | 仅适用于支付宝 openapi 接口。其他出资方出资金额,可能是支付宝,可能是品牌商,或者其他方,也可能是他们的一起出资。 |
memo response-only,string | 仅适用于支付宝 openapi 接口。优惠券备注信息。 |
alipay_wap(支付宝手机网站支付)
extra 参数 | 说明 |
---|
success_url required string | 支付成功的回调地址。回调 HTTP 方法为 GET |
cancel_url optional, string | 支付取消的回调地址,仅适用于支付宝 mapi 接口。当 app_pay 为 true 时,该字段无效。 |
app_pay optional,boolean | 是否使用支付宝客户端支付,仅适用于支付宝 mapi 接口。当该参数为 true 时,调用客户端支付。 |
hb_fq_num optional,int | 仅适用于支付宝 openapi 接口,hb_fq_num 和 hb_fq_seller_percent 必须同时传入有效。使用花呗分期要进行的分期数,必须根据支付宝签约的分期数填写,可选值:3、6、12。 |
hb_fq_seller_percent optional,int | 仅适用于支付宝 openapi 接口,hb_fq_num 和 hb_fq_seller_percent 必须同时传入有效。使用花呗分期需要卖家承担的手续费比例的百分值,传入100代表100%,可选值:0、100。 |
disable_pay_channels optional,string | 仅适用于支付宝 openapi 接口。禁用支付渠道,用户不可用禁用的渠道支付,当有多个付款渠道需禁用时,用,分隔(如moneyFund,credit_group),可禁用的支付渠道相关值参考下方 disable_pay_channels 参数说明 。 |
need_buyer_real_named optional,string | 适用于支付宝 openapi 接口。是否发起实名校验,T 代表发起实名校验;F 代表不发起实名校验。 |
sys_service_provider_id optional,string | 仅适用于支付宝 openapi 接口。系统商编号,该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的 PID。 |
new_version optional,boolean | 2016 年 6 月 16 日之前登录 Ping++ 管理平台填写支付宝手机网站的渠道参数的旧接口商户,需要更新接口时设置此参数值为 true,6 月 16 号后接入的新接口商户不需要设置该参数。 |
extern_token optional, string | 仅适用于支付宝 mapi 接口。开放平台返回的包含账户信息的 token(授权令牌,商户在一定时间内对支付宝某些服务的访问权限)。通过授权登录后获取的 alipay_open_id ,作为该参数的 value ,登录授权账户即会为支付账户,32 位字符串。 |
buyer_account response-only, string | 适用于支付宝 openapi 接口。支付完成将额外返回付款用户的支付宝账号。 |
fund_bill_list response-only,array | 适用于支付宝 openapi 接口。交易支付使用的资金渠道,详见下方的 fund_bill_list 渠道透传返回 。 |
buyer_user_id response-only,string | 适用于支付宝 openapi 接口。买家在支付宝的用户 id 。 |
voucher_detail_list response-only,array | 适用于支付宝 openapi 接口。本交易支付时使用的所有优惠券信息,详见下方的 voucher_detail_list 渠道透传返回 。 |
disable_pay_channels 参数说明
extra 参数 | 说明 |
---|
balance | 余额 |
moneyFund | 余额宝 |
coupon | 红包 |
pcredit | 花呗 |
pcreditpayInstallment | 花呗分期 |
creditCard | 信用卡 |
creditCardExpress | 信用卡快捷 |
creditCardCartoon | 信用卡卡通 |
credit_group | 信用支付类型(包含信用卡卡通、信用卡快捷、花呗、花呗分期) |
debitCardExpress | 借记卡快捷 |
mcard | 商户预存卡 |
pcard | 个人预存卡 |
promotion | 优惠(包含实时优惠+商户优惠) |
voucher | 营销券 |
point | 积分 |
mdiscount | 商户优惠 |
bankPay | 网银 |
fund_bill_list 渠道返回参数
extra 参数 | 说明 |
---|
fund_channel response-only,string | 仅适用于支付宝 openapi 接口。交易使用的资金渠道,详见 alipay 支付渠道列表 。 |
amount response-only,string | 仅适用于支付宝 openapi 接口。该支付工具类型所使用的金额。 |
real_amount response-only,string | 仅适用于支付宝 openapi 接口。渠道实际付款金额。 |
alipay 支付渠道列表
extra 参数 | 说明 |
---|
COUPON | 支付宝红包 |
ALIPAYACCOUNT | 支付宝账户 |
POINT | 集分宝 |
DISCOUNT | 折扣券 |
PCARD | 预付卡 |
MCARD | 商家储值卡 |
MDISCOUNT | 商户优惠券 |
MCOUPON | 商户红包 |
PCREDIT | 蚂蚁花呗 |
voucher_detail_list 渠道返回参数
extra 参数 | 说明 |
---|
id response-only,string | 仅适用于支付宝 openapi 接口。券 id。 |
name response-only,string | 仅适用于支付宝 openapi 接口。券名称。 |
type response-only,string | 仅适用于支付宝 openapi 接口。当前有三种类型: ALIPAY_FIX_VOUCHER - 全场代金券、ALIPAY_DISCOUNT_VOUCHER - 折扣券、ALIPAY_ITEM_VOUCHER - 单品优惠。注:不排除将来新增其他类型的可能,商家接入时注意兼容性避免硬编码。 |
amount response-only,string | 仅适用于支付宝 openapi 接口。优惠券面额,它应该会等于商家出资加上其他出资方出资。 |
merchant_contribute response-only,string | 仅适用于支付宝 openapi 接口。商家出资(特指发起交易的商家出资金额)。 |
other_contribute response-only,string | 仅适用于支付宝 openapi 接口。其他出资方出资金额,可能是支付宝,可能是品牌商,或者其他方,也可能是他们的一起出资。 |
memo response-only,string | 仅适用于支付宝 openapi 接口。优惠券备注信息。 |
alipay_qr(支付宝扫码支付)
extra 参数 | 说明 |
---|
hb_fq_num optional,int | 使用花呗分期要进行的分期数,hb_fq_num 和 hb_fq_seller_percent 必须同时传入有效。必须根据支付宝签约的分期数填写,可选值:3、6、12。 |
hb_fq_seller_percent optional,int | 使用花呗分期需要卖家承担的手续费比例的百分值,hb_fq_num 和 hb_fq_seller_percent 必须同时传入有效。传入100代表100%,可选值:0、100。 |
disable_pay_channels optional,string | 禁用支付渠道,用户不可用指定渠道支付,当有多个付款渠道时用, 分隔(如moneyFund,credit_group),支付渠道相关值参考下方 disable_pay_channels 参数说明 。 |
trade_create boolean,string | 是否使用口碑支付,true 则使用口碑支付。 |
sys_service_provider_id optional,string | 系统商编号,该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的 PID。 |
buyer_account optional,string | 支付宝账号。当 trade_create 为 true 时,buyer_account 和 buyer_user_id 必填一个;当 trade_create 为 false 时,此参数无需填写,会在支付完成后额外返回。 |
buyer_user_id optional,string | 买家的支付宝唯一用户 id,2088 开头的 16 位纯数字。当 trade_create 为 true 时,buyer_account 和 buyer_user_id 必填一个;当 trade_create 为 false 时,此参数无需填写,会在支付完成后额外返回。 |
fund_bill_list response-only,array | 交易支付使用的资金渠道,详见下方的 fund_bill_list 渠道透传返回 。 |
voucher_detail_list response-only,array | 本交易支付时使用的所有优惠券信息,详见下方的 voucher_detail_list 渠道透传返回 。 |
disable_pay_channels 参数说明
extra 参数 | 说明 |
---|
balance | 余额 |
moneyFund | 余额宝 |
coupon | 红包 |
pcredit | 花呗 |
pcreditpayInstallment | 花呗分期 |
creditCard | 信用卡 |
creditCardExpress | 信用卡快捷 |
creditCardCartoon | 信用卡卡通 |
credit_group | 信用支付类型(包含信用卡卡通、信用卡快捷、花呗、花呗分期) |
debitCardExpress | 借记卡快捷 |
mcard | 商户预存卡 |
pcard | 个人预存卡 |
promotion | 优惠(包含实时优惠+商户优惠) |
voucher | 营销券 |
point | 积分 |
mdiscount | 商户优惠 |
bankPay | 网银 |
fund_bill_list 渠道返回参数
extra 参数 | 说明 |
---|
fund_channel response-only,string | 仅适用于支付宝 openapi 接口。交易使用的资金渠道,详见 alipay 支付渠道列表 。 |
amount response-only,string | 仅适用于支付宝 openapi 接口。该支付工具类型所使用的金额。 |
real_amount response-only,string | 仅适用于支付宝 openapi 接口。渠道实际付款金额。 |
alipay 支付渠道列表
extra 参数 | 说明 |
---|
COUPON | 支付宝红包 |
ALIPAYACCOUNT | 支付宝账户 |
POINT | 集分宝 |
DISCOUNT | 折扣券 |
PCARD | 预付卡 |
MCARD | 商家储值卡 |
MDISCOUNT | 商户优惠券 |
MCOUPON | 商户红包 |
PCREDIT | 蚂蚁花呗 |
voucher_detail_list 渠道返回参数
extra 参数 | 说明 |
---|
id response-only,string | 仅适用于支付宝 openapi 接口。券 id。 |
name response-only,string | 仅适用于支付宝 openapi 接口。券名称。 |
type response-only,string | 仅适用于支付宝 openapi 接口。当前有三种类型: ALIPAY_FIX_VOUCHER - 全场代金券、ALIPAY_DISCOUNT_VOUCHER - 折扣券、ALIPAY_ITEM_VOUCHER - 单品优惠。注:不排除将来新增其他类型的可能,商家接入时注意兼容性避免硬编码。 |
amount response-only,string | 仅适用于支付宝 openapi 接口。优惠券面额,它应该会等于商家出资加上其他出资方出资。 |
merchant_contribute response-only,string | 仅适用于支付宝 openapi 接口。商家出资(特指发起交易的商家出资金额)。 |
other_contribute response-only,string | 仅适用于支付宝 openapi 接口。其他出资方出资金额,可能是支付宝,可能是品牌商,或者其他方,也可能是他们的一起出资。 |
memo response-only,string | 仅适用于支付宝 openapi 接口。优惠券备注信息。 |
alipay_scan(支付宝条码支付)
extra 参数 | 说明 |
---|
scan_code required string | 支付宝客户端付款条形码的数值,1-32位,由扫码设备扫描获取。 |
terminal_id required string | 终端号(可包含字母、数字、下划线、中划线),1-32位。 |
goods_list optional,list | 订单包含的商品列表信息(json 字符串的长度为1~8000)。 |
operator_id optional,string | 商户操作员编号(可包含字母、数字、下划线、中划线),1-28位。 |
store_id optional,string | 商户门店编号(可包含字母、数字、下划线、中划线),1-32位。 |
sys_service_provider_id optional,string | 系统商编号,1-64位。 |
goods_list 参数说明
参数 | 说明 |
---|
goods_id required string | 商品的编号,1-32位。 |
goods_name required string | 商品名称,1-256位。 |
quantity required int | 商品数量,1-10位。 |
price required string | 商品单价,单位为元,1-9位。 |
goods_category optional,string | 商品类目,1-24位。 |
body optional,string | 商品描述信息,1-1000位。 |
show_url optional,string | 商品的展示地址,1-400位。 |
alipay_lite(支付宝小程序支付)
extra 参数 | 说明 |
---|
buyer_user_id required string | 买家支付宝 ID。 |
sys_service_provider_id optional,string | 系统商编号,该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的 PID。 |
buyer_account response-only,string | 支付完成将额外返回付款用户的支付宝账号。 |
fund_bill_list response-only,array | 交易支付使用的资金渠道,详见下方的 fund_bill_list 渠道透传返回 。 |
fund_bill_list 渠道返回参数
extra 参数 | 说明 |
---|
fund_channel response-only,string | 交易使用的资金渠道,详见 alipay 支付渠道列表 。 |
amount response-only,string | 该支付工具类型所使用的金额。 |
real_amount response-only,string | 渠道实际付款金额。 |
alipay 支付渠道列表
extra 参数 | 说明 |
---|
COUPON | 支付宝红包 |
ALIPAYACCOUNT | 支付宝账户余额 |
POINT | 集分宝 |
DISCOUNT | 折扣券 |
PCARD | 预付卡 |
MCARD | 商家店铺卡 |
MDISCOUNT | 商户优惠券 |
MCOUPON | 商户红包 |
alipay_pc_direct(支付宝电脑网站支付)
extra 参数 | 说明 |
---|
success_url optional,string | 支付成功的回调地址。当支付宝电脑网站为 mapi 版本,此参数必传;当支付宝电脑网站为 openapi 版本,此参数可选。回调 HTTP 方法为 GET |
hb_fq_num optional,int | 仅适用于支付宝 openapi 接口,hb_fq_num 和 hb_fq_seller_percent 必须同时传入有效。使用花呗分期要进行的分期数,必须根据支付宝签约的分期数填写,可选值:3、6、12。 |
hb_fq_seller_percent optional,int | 仅适用于支付宝 openapi 接口,hb_fq_num 和 hb_fq_seller_percent 必须同时传入有效。使用花呗分期需要卖家承担的手续费比例的百分值,传入100代表100%,可选值:0、100。 |
disable_pay_channels optional,string | 仅适用于支付宝 openapi 接口。禁用支付渠道,用户不可用禁用的渠道支付,当有多个付款渠道需禁用时,用,分隔(如moneyFund,credit_group),可禁用的支付渠道相关值参考下方 disable_pay_channels 参数说明 。 |
qr_pay_mode optional,int | PC 扫码支付的方式,支持前置模式和跳转模式。可选值:0、1、2、3、4,qr_pay_mode 说明 。 |
qrcode_width optional,int | 商户自定义二维码宽度。qr_pay_mode = 4 时该参数生效。 |
sys_service_provider_id optional,string | 仅适用于支付宝 openapi 接口。系统商编号,该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的 PID。 |
exter_invoke_ip optional,string | 仅适用于支付宝 mapi 接口。客户端 IP ,用户在创建交易时,该用户当前所使用机器的IP(如果商户申请后台开通防钓鱼IP地址检查选项,此字段必填,校验用)。 |
enable_anti_phishing_key optional,boolean | 仅适用于支付宝 mapi 接口。是否开启防钓鱼网站的验证参数(如果已申请开通防钓鱼时间戳验证,则此字段必填)。 |
buyer_account response-only,string | 适用于支付宝 openapi 接口。支付完成将额外返回付款用户的支付宝账号。 |
buyer_user_id response-only,string | 适用于支付宝 openapi 接口。买家在支付宝的用户 id 。 |
fund_bill_list response-only,array | 适用于支付宝 openapi 接口。交易支付使用的资金渠道,详见下方的 fund_bill_list 渠道透传返回 。 |
voucher_detail_list response-only,array | 适用于支付宝 openapi 接口。本交易支付时使用的所有优惠券信息,详见下方的voucher_detail_list 渠道透传返回 。 |
is_absolute_time optional,boolean | 是否使用绝对超时时间,如 true,time_expire 参数为绝对时间。 |
disable_pay_channels 参数说明
extra 参数 | 说明 |
---|
balance | 余额 |
moneyFund | 余额宝 |
coupon | 红包 |
pcredit | 花呗 |
pcreditpayInstallment | 花呗分期 |
creditCard | 信用卡 |
creditCardExpress | 信用卡快捷 |
creditCardCartoon | 信用卡卡通 |
credit_group | 信用支付类型(包含信用卡卡通、信用卡快捷、花呗、花呗分期) |
debitCardExpress | 借记卡快捷 |
mcard | 商户预存卡 |
pcard | 个人预存卡 |
promotion | 优惠(包含实时优惠+商户优惠) |
voucher | 营销券 |
point | 积分 |
mdiscount | 商户优惠 |
bankPay | 网银 |
fund_bill_list 渠道返回参数
extra 参数 | 说明 |
---|
fund_channel response-only,string | 仅适用于支付宝 openapi 接口。交易使用的资金渠道,详见 alipay 支付渠道列表 。 |
amount response-only,string | 仅适用于支付宝 openapi 接口。该支付工具类型所使用的金额。 |
real_amount response-only,string | 仅适用于支付宝 openapi 接口。渠道实际付款金额。 |
alipay 支付渠道列表
extra 参数 | 说明 |
---|
COUPON | 支付宝红包 |
ALIPAYACCOUNT | 支付宝账户 |
POINT | 集分宝 |
DISCOUNT | 折扣券 |
PCARD | 预付卡 |
MCARD | 商家储值卡 |
MDISCOUNT | 商户优惠券 |
MCOUPON | 商户红包 |
PCREDIT | 蚂蚁花呗 |
voucher_detail_list 渠道返回参数
extra 参数 | 说明 |
---|
id response-only,string | 仅适用于支付宝 openapi 接口。券 id。 |
name response-only,string | 仅适用于支付宝 openapi 接口。券名称。 |
type response-only,string | 仅适用于支付宝 openapi 接口。当前有三种类型: ALIPAY_FIX_VOUCHER - 全场代金券、ALIPAY_DISCOUNT_VOUCHER - 折扣券、ALIPAY_ITEM_VOUCHER - 单品优惠。注:不排除将来新增其他类型的可能,商家接入时注意兼容性避免硬编码。 |
amount response-only,string | 仅适用于支付宝 openapi 接口。优惠券面额,它应该会等于商家出资加上其他出资方出资。 |
merchant_contribute response-only,string | 仅适用于支付宝 openapi 接口。商家出资(特指发起交易的商家出资金额)。 |
other_contribute response-only,string | 仅适用于支付宝 openapi 接口。其他出资方出资金额,可能是支付宝,可能是品牌商,或者其他方,也可能是他们的一起出资。 |
memo response-only,string | 仅适用于支付宝 openapi 接口。优惠券备注信息。 |
wx(微信 App 支付)
extra 参数 | 说明 |
---|
limit_pay optional,string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit 。 |
goods_tag optional,string | 商品标记,代金券或立减优惠功能的参数。 |
receipt optional,boolean | 是否开启电子发票入口开放标识。true :开启,false :不开启,不传默认 false |
open_id response-only, string | 支付完成后额外返回付款用户的微信 open_id 。 |
bank_type response-only,string | 支付完成后额外返回付款用户的付款银行类型 bank_type 。 |
device_info response-only,string | 设备号:微信支付分配的终端设备号 |
is_subscribe response-only,string | 用户是否关注公众账号,仅在公众账号类型支付有效。取值范围:Y 或者N 。Y 表示关注,N 表示未关注。 |
coupon_fee response-only,int | 代金券金额。代金券金额 <= 订单金额,订单金额 - 代金券金额 = 现金支付金额。 |
coupon_count response-only,int | 代金券使用数量。 |
coupon_type_$n response-only,string | 代金券类型。CASH :充值代金券;NO_CASH :非充值代金券。订单使用代金券时有返回(取值:CASH 、NO_CASH )。$n 为下标,从0开始编号,举例:coupon_type_$0 。 |
coupon_id_$n response-only,string | 代金券ID,$n 为下标,从0开始编号。 |
coupon_fee_$n response-only,int | 单个代金券支付金额,$n 为下标,从0开始编号。 |
wx_pub(微信 JSAPI 支付)
extra 参数 | 说明 |
---|
limit_pay optional,string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit 。 |
goods_tag optional,string | 商品标记,代金券或立减优惠功能的参数。 |
open_id required string | 用户在商户 appid 下的唯一标识。点此参考 如何获取 open_id 。 |
receipt optional,boolean | 是否开启电子发票入口开放标识。true :开启,false :不开启,不传默认 false |
bank_type response-only, string | 支付完成后额外返回付款用户的付款银行类型 bank_type 。 |
device_info response-only,string | 设备号:微信支付分配的终端设备号 |
is_subscribe response-only,string | 用户是否关注公众账号,仅在公众账号类型支付有效。取值范围:Y 或者N 。Y 表示关注,N 表示未关注。 |
coupon_fee response-only,int | 代金券金额。代金券金额 <= 订单金额,订单金额 - 代金券金额 = 现金支付金额。 |
coupon_count response-only,int | 代金券使用数量。 |
coupon_type_$n response-only,string | 代金券类型。CASH :充值代金券;NO_CASH :非充值代金券。订单使用代金券时有返回(取值:CASH 、NO_CASH )。$n 为下标,从0开始编号,举例:coupon_type_$0 。 |
coupon_id_$n response-only,string | 代金券ID,$n 为下标,从0开始编号。 |
coupon_fee_$n response-only,int | 单个代金券支付金额,$n 为下标,从0开始编号。 |
wx_pub_qr(微信 Native 支付)
extra 参数 | 说明 |
---|
limit_pay optional,string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit 。 |
product_id required string | 商品 ID,1-32 位字符串。此 id 为二维码中包含的商品 ID,商户自行维护。 |
goods_tag optional,string | 商品标记,代金券或立减优惠功能的参数。 |
receipt optional,boolean | 是否开启电子发票入口开放标识。true :开启,false :不开启,不传默认 false |
open_id response-only, string | 支付完成后额外返回付款用户的微信 open_id 。 |
bank_type response-only, string | 支付完成后额外返回付款用户的付款银行类型 bank_type 。 |
device_info response-only,string | 设备号:微信支付分配的终端设备号 |
is_subscribe response-only,string | 用户是否关注公众账号,仅在公众账号类型支付有效。取值范围:Y 或者N 。Y 表示关注,N 表示未关注。 |
coupon_fee response-only,int | 代金券金额。代金券金额 <= 订单金额,订单金额 - 代金券金额 = 现金支付金额。 |
coupon_count response-only,int | 代金券使用数量。 |
coupon_type_$n response-only,string | 代金券类型。CASH :充值代金券;NO_CASH :非充值代金券。订单使用代金券时有返回(取值:CASH 、NO_CASH )。$n 为下标,从0开始编号,举例:coupon_type_$0 。 |
coupon_id_$n response-only,string | 代金券ID,$n 为下标,从0开始编号。 |
coupon_fee_$n response-only,int | 单个代金券支付金额,$n 为下标,从0开始编号。 |
wx_pub_scan(微信付款码支付)
extra 参数 | 说明 |
---|
scan_code required string | 微信客户端付款条形码的数值,1-32位,由扫码设备扫描获取。 |
terminal_id optional,string | 终端号,要求不同终端此号码不一样,会显示在对账单中,如A01 、SH008 等,1-8位。 |
limit_pay optional,string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit 。 |
goods_tag optional,string | 商品标记,代金券或立减优惠功能的参数,1-32位。 |
receipt optional,boolean | 是否开启电子发票入口开放标识。true :开启,false :不开启,不传默认 false |
open_id response-only, string | 用户在商户下的唯一标识。 |
is_subscribe response-only, string | 用户是否关注公众账号,仅在公众账号类型支付有效。取值范围:Y 或者N 。Y 表示关注,N 表示未关注。 |
bank_type response-only, string | 银行类型,采用字符串类型的银行标识。 |
settlement_total_fee response-only, int | 应结订单金额,当订单使用了免充值型优惠券后返回该参数。应结订单金额 = 订单金额 - 免充值优惠券金额。 |
coupon_fee response-only, int | 代金券金额。代金券金额 <= 订单金额,订单金额 - 代金券金额 = 现金支付金额。 |
cash_fee response-only, int | 现金支付金额。 |
promotion_detail response-only, string | 营销详情。 |
wx_lite(微信小程序支付)
extra 参数 | 说明 |
---|
limit_pay optional,string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit 。 |
goods_tag optional,string | 商品标记,代金券或立减优惠功能的参数。 |
open_id required string | 用户在商户 appid 下的唯一标识。点此参考 如何获取 open_id 。 |
receipt optional,boolean | 是否开启电子发票入口开放标识。true :开启,false :不开启,不传默认 false |
bank_type response-only, string | 支付完成后额外返回付款用户的付款银行类型 bank_type 。 |
device_info response-only,string | 设备号:微信支付分配的终端设备号 |
is_subscribe response-only,string | 用户是否关注公众账号,仅在公众账号类型支付有效。取值范围:Y 或者N 。Y 表示关注,N 表示未关注。 |
coupon_fee response-only,int | 代金券金额。代金券金额 <= 订单金额,订单金额 - 代金券金额 = 现金支付金额。 |
coupon_count response-only,int | 代金券使用数量。 |
coupon_type_$n response-only,string | 代金券类型。CASH :充值代金券;NO_CASH :非充值代金券。订单使用代金券时有返回(取值:CASH 、NO_CASH )。$n 为下标,从0开始编号,举例:coupon_type_$0 。 |
coupon_id_$n response-only,string | 代金券ID,$n 为下标,从0开始编号。 |
coupon_fee_$n response-only,int | 单个代金券支付金额,$n 为下标,从0开始编号。 |
wx_wap(微信 H5 支付)
extra 参数 | 说明 |
---|
result_url optional,string | 支付完成的回调地址。 |
limit_pay optional,string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit 。 |
goods_tag optional,string | 商品标记,代金券或立减优惠功能的参数。 |
receipt optional,boolean | 是否开启电子发票入口开放标识。true :开启,false :不开启,不传默认 false |
open_id response-only, string | 支付完成后额外返回付款用户的微信 open_id 。 |
bank_type response-only, string | 支付完成后额外返回付款用户的付款银行类型 bank_type 。 |
device_info response-only,string | 设备号:微信支付分配的终端设备号 |
is_subscribe response-only,string | 用户是否关注公众账号,仅在公众账号类型支付有效。取值范围:Y 或者N 。Y 表示关注,N 表示未关注。 |
coupon_fee response-only,int | 代金券金额。代金券金额 <= 订单金额,订单金额 - 代金券金额 = 现金支付金额。 |
coupon_count response-only,int | 代金券使用数量。 |
coupon_type_$n response-only,string | 代金券类型。CASH :充值代金券;NO_CASH :非充值代金券。订单使用代金券时有返回(取值:CASH 、NO_CASH )。$n 为下标,从0开始编号,举例:coupon_type_$0 。 |
coupon_id_$n response-only,string | 代金券ID,$n 为下标,从0开始编号。 |
coupon_fee_$n response-only,int | 单个代金券支付金额,$n 为下标,从0开始编号。 |
qpay(QQ 钱包 App 支付)
extra 参数 | 说明 |
---|
device required string | 客户端设备类型,取值范围: "ios" ,"android"。 |
qpay_pub(QQ 钱包公众号支付)
extra 参数 | 说明 |
---|
device_info optional,string | 调用接口提交的终端设备号。 |
limit_pay optional,string | 支付方式限制,可以针对当前的交易限制用户的支付方式,如:仅允许使用余额,或者是禁止使用信用卡,详情见下方 支付方式限制说明 。 |
promotion_tag optional,string | 指定本单参与某个 QQ 钱包活动或活动档位的标识,包含两个标识。sale_tag:不同活动的匹配标志;level_tag:同一活动不同优惠档位的标志,可不填。格式如下(本字段参与签名):promotion_tag=urlencode(level_tag=xxx&sale_tag=xxx) |
attach optional,string | 附加数据,在查询 API 和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据。 |
openid response-only,string | 用户在商户appid下的唯一标识,示例:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
bank_type response-only,string | 银行类型,采用字符串类型的银行卡标识,示例:CCB_DEBIT。值列表详见 支持的付款银行列表 。 |
支付方式限制说明
参数 | 说明 |
---|
no_balance | 不准使用余额 |
no_credit | 不准使用信用卡 |
no_debit | 不准使用借记卡 |
balance_only | 只准使用余额 |
debit_only | 只准使用借记卡 |
NoBindNoBalan | 简化注册用户不允许用余额 |
upacp(银联手机控件支付)
extra 参数 | 说明 |
---|
pay_type response-only, string | 支付方式(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。0001:认证支付;0002:快捷支付;0004:储值卡支付;0005:IC卡支付;0201:网银支付;1001:牡丹畅通卡支付;1002:中铁银通卡支付;0401:信用卡支付;0402:小额临时支付;0403:认证支付 2.0;0404:互联网订单手机支付;9000:其他无卡支付(如手机客户端支付)。 |
acc_no response-only, string | 银行卡号(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准,开通后默认返回打码后的卡号)。 |
pay_card_type response-only, string | 支付卡类型(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。00:未知;01:借记账户;02:贷记账户;03:准贷记账户;04:借贷合一账户;05:预付费账户;06:半开放预付费账户。 |
discount_code optional, string | 上传该值表示此订单参与营销活动. |
upacp_wap(银联手机网站支付)
extra 参数 | 说明 |
---|
result_url required string | 支付完成的回调地址。回调 HTTP 方法为 POST |
pay_type response-only, string | 支付方式(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。0001:认证支付;0002:快捷支付;0004:储值卡支付;0005:IC卡支付;0201:网银支付;1001:牡丹畅通卡支付;1002:中铁银通卡支付;0401:信用卡支付;0402:小额临时支付;0403:认证支付 2.0;0404:互联网订单手机支付;9000:其他无卡支付(如手机客户端支付)。 |
acc_no response-only, string | 银行卡号(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准,开通后默认返回打码后的卡号)。 |
pay_card_type response-only, string | 支付卡类型(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。00:未知;01:借记账户;02:贷记账户;03:准贷记账户;04:借贷合一账户;05:预付费账户;06:半开放预付费账户。 |
upacp_pc(银联网关支付)
extra 参数 | 说明 |
---|
result_url required string | 支付完成的回调地址。回调 HTTP 方法为 POST |
iss_ins_code optional,string | 直接跳转到银行网银,商户界面点击银行网银图标直接跳转到银行网银支付,详见下方的 iss_ins_code 字段说明 。 |
pay_type response-only, string | 支付方式(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。0001:认证支付;0002:快捷支付;0004:储值卡支付;0005:IC卡支付;0201:网银支付;1001:牡丹畅通卡支付;1002:中铁银通卡支付;0401:信用卡支付;0402:小额临时支付;0403:认证支付 2.0;0404:互联网订单手机支付;9000:其他无卡支付(如手机客户端支付)。 |
acc_no response-only, string | 银行卡号(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准,开通后默认返回打码后的卡号)。 |
pay_card_type response-only, string | 支付卡类型(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。00:未知;01:借记账户;02:贷记账户;03:准贷记账户;04:借贷合一账户;05:预付费账户;06:半开放预付费账户。 |
iss_ins_code 字段说明
支持标准网关银行列表
代码 | 描述 |
---|
ICBC | 工商银行 |
ABC | 农业银行 |
BOC | 中国银行(大额) |
BOCSH | 中国银行 |
CCB | 建设银行 |
CMB | 招行银行 |
SPDB | 浦发银行 |
GDB | 广发银行 |
BOCOM | 交通银行 |
CNCB | 中信银行 |
CMBC | 民生银行 |
CIB | 兴业银行 |
CEB | 光大银行 |
HXB | 华夏银行 |
BOS | 上海银行 |
SRCB | 上海农商 |
PSBC | 邮政储蓄 |
BCCB | 北京银行 |
BRCB | 北京农商 |
PAB | 平安银行 |
支持的独立借记卡网关银行列表
代码 | 描述 |
---|
ICBCD | 工商银行 |
CCBD | 建设银行 |
CMBD | 招行银行 |
SPDBD | 上海浦东发展银行 |
GDBD | 广发银行 |
PSBCD | 邮政储蓄银行 |
CMBCD | 民生银行 |
CEBD | 光大银行 |
HXB | 华夏银行 |
BOEAD | 东亚银行 |
ABCD | 中国农业银行 |
upacp_qr(银联二维码(主扫))
注:银联支持扫码 APP 列表
extra 参数 | 说明 |
---|
result_url required string | 支付完成的回调地址。 |
pay_type response-only, string | 支付方式(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。0001:认证支付;0002:快捷支付;0004:储值卡支付;0005:IC卡支付;0201:网银支付;1001:牡丹畅通卡支付;1002:中铁银通卡支付;0401:信用卡支付;0402:小额临时支付;0403:认证支付 2.0;0404:互联网订单手机支付;9000:其他无卡支付(如手机客户端支付)。 |
acc_no response-only, string | 银行卡号(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准,开通后默认返回打码后的卡号)。 |
pay_card_type response-only, string | 支付卡类型(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。00:未知;01:借记账户;02:贷记账户;03:准贷记账户;04:借贷合一账户;05:预付费账户;06:半开放预付费账户。 |
upacp_scan(银联二维码(被扫))
- 银联支持扫码 APP 列表
- 银联被扫支付非实时返回支付结果,必须调用 主动查询
- 调用银联 撤销支付接口 时,已支付金额会实时退款到原支付账户。调用撤销接口后,必须调用 查询接口 获取撤销结果
extra 参数 | 说明 |
---|
scan_code required string | 手机客户端付款条形码的数值,由扫码设备扫描获取。 |
terminal_id optional,string | 终端 ID,原则是可以通过交易上送的终端编号准确定位商户每一个门店内的每一台收银设备。建议按 “门店编号+收银机编号” 或 “设备编号” 组成 8 位终端编号在交易中上送。商户需将终端编号与门店对应关系反馈给银联。 |
term_info optional,hash | 终端信息,详见下方的 term_info 字段说明 。 |
pay_type response-only, string | 支付方式(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。0001:认证支付;0002:快捷支付;0004:储值卡支付;0005:IC卡支付;0201:网银支付;1001:牡丹畅通卡支付;1002:中铁银通卡支付;0401:信用卡支付;0402:小额临时支付;0403:认证支付 2.0;0404:互联网订单手机支付;9000:其他无卡支付(如手机客户端支付)。 |
acc_no response-only, string | 银行卡号(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准,开通后默认返回打码后的卡号)。 |
pay_card_type response-only, string | 支付卡类型(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。00:未知;01:借记账户;02:贷记账户;03:准贷记账户;04:借贷合一账户;05:预付费账户;06:半开放预付费账户。 |
term_info 字段说明
参数 | 类型 | 长度 | 是否必须 | 描述 |
---|
longitude | string | [1~10] | optional | 终端的实时经度信息。格式:3位整数+1位小数点+6位小数,例如:121.483527 |
latitude | string | [1~10] | optional | 终端的实时纬度信息。格式:1位正负号+2位整数+1位小数点+6位小数,例如:+31.221345 或 -03.561345 |
network_license | string | [5] | optional | 银行卡受理终端产品入网认证编号。该编号由“中国银联标识产品企业资质认证办公室”为通过入网认证的终端进行分配。格式:5位字符,例如:P3100 |
term_device_type | string | [2] | optional | 终端设备类型,取值如下:01:自动柜员机(含ATM和CDM)和多媒体自助终端,02:传统POS,03:mPOS,04:智能POS,05:II型固定电话 |
serial_num | string | [1~50] | optional | 终端设备的硬件序列号能采集则上送 |
encrypt_rand_num | string | [1~50] | optional | 仅在被扫支付类交易报文中出现:若 C2B 码为19位数字,则取后6位;若 C2B 码为EMV二维码,则取其 tag 57 的卡号/token号的后6位 |
secret_text | string | [6~16] | optional | 仅在被扫支付类交易报文中出现:64bit的密文数据,对终端硬件序列号和加密随机因子加密后的结果。本子域取值为:64bit密文数据进行base64编码后的结果。 |
app_version | string | 8 | optional | 终端应用程序的版本号。应用程序变更应保证版本号不重复。当长度不足时,右补空格。 |
upacp_b2b(银联企业网银支付)
extra 参数 | 说明 |
---|
result_url required string | 返回商户结果的前端回调地址。回调 HTTP 方法为 POST |
pay_type response-only, string | 支付方式(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。0001:认证支付;0002:快捷支付;0004:储值卡支付;0005:IC卡支付;0201:网银支付;1001:牡丹畅通卡支付;1002:中铁银通卡支付;0401:信用卡支付;0402:小额临时支付;0403:认证支付 2.0;0404:互联网订单手机支付;9000:其他无卡支付(如手机客户端支付)。 |
acc_no response-only, string | 银行卡号(已打码)。 |
pay_card_type response-only, string | 支付卡类型(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。00:未知;01:借记账户;02:贷记账户;03:准贷记账户;04:借贷合一账户;05:预付费账户;06:半开放预付费账户。 |
applepay_upacp(Apple Pay)
extra 参数 | 说明 |
---|
pay_type response-only, string | 支付方式(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。0001:认证支付;0002:快捷支付;0004:储值卡支付;0005:IC卡支付;0201:网银支付;1001:牡丹畅通卡支付;1002:中铁银通卡支付;0401:信用卡支付;0402:小额临时支付;0403:认证支付 2.0;0404:互联网订单手机支付;9000:其他无卡支付(如手机客户端支付)。 |
acc_no response-only, string | 银行卡号(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准,开通后默认返回打码后的卡号)。 |
pay_card_type response-only, string | 支付卡类型(默认不返回,如需返回,需联系银联入网所在收单行提交开通申请,具体开通资料以所在收单行为准)。00:未知;01:借记账户;02:贷记账户;03:准贷记账户;04:借贷合一账户;05:预付费账户;06:半开放预付费账户。 |
jdpay_wap(京东支付)
extra 参数 | 说明 |
---|
success_url required string | 支付成功页面跳转路径。回调 HTTP 方法为 POST |
fail_url required string | 支付失败页面跳转路径。 |
user_id required string | 商户端系统内的用户唯一账号。首次支付成功后 user_id 会和用户登陆的手机号做绑定,下次此 user_id 用户再发起支付时,无需再次登录即可完成支付。 |
user_type optional,string | 用户账号类型。取值只能为:BIZ |
pre_product optional,string | 前置支付方式。可选值:BAITIAO_FEN(白条分期)、BAITIAO_ONE(白条支付)。 |
installment_num optional,string | 分期数。可选值:3、6、12、24,当 pre_product 为 "BAITIAO_FEN" 时该字段必填。 |
risk_info optional,hash | 风控信息,如需使用白条分期、白条支付,则此字段必传。详见下方的 risk_info 字段说明 。 |
receiver_info optional,hash | 收货信息,如需使用白条分期、白条支付,则此字段建议传递。详见下方的 receiver_info 字段说明 。 |
term_info optional,hash | 终端信息,如需使用白条分期、白条支付,则此字段建议传递。详见下方的 term_info 字段说明 。 |
token optional,string | 用户交易令牌,用于识别用户信息,支付成功后会调用 success_url 返回给商户。商户可以记录这个 token 值,当用户再次支付的时候传入该 token ,用户无需再次输入银行卡信息,直接输入短信验证码进行支付。32 位字符串。 |
order_type optional,int | 订单类型,可选值:0、1。值为 0 表示实物商品订单,值为 1 代表虚拟商品订单,默认值为 0 。 |
is_mobile optional,boolean | 设置是否通过手机端发起支付,值为 true 时调用手机 h5 支付页面,值为 false 时调用 PC 端支付页面,该参数默认值为 true 。 |
pay_list response-only,string | 支付完成后额外返回给用户的支付方式明细列表,具体参考下方 pay_list 参数说明 。 |
风控信息 risk_info 字段说明
参数 | 说明 |
---|
industry_category_code required string | 订单业务类型。取值范围:"1":购买商品或提供服务的费用(餐饮、服饰、美容美发、租房、租车、机票、住宿费用等)、"2":充值(会员、虚拟代币、话费、加油卡等充值)、"3":押金(商品租赁或信用担保所提供的押金)、"4":其他 |
product_category_id required string | 商品品类编号 |
product_category_name required string | 商品品类名称 |
merchant_user_id required string | 商户平台用户的唯一账号。注:用户账号是商品端系统的用户唯一账号 |
trade_desc optional,string | 商品名称或订单描述 |
order_goods_num optional,string | 订单商品数量 |
收货信息 receiver_info 字段说明
参数 | 说明 |
---|
name optional,string | 收货人姓名 |
address optional,string | 收货地址 |
mobile optional,string | 收货手机号 |
phone optional,string | 收货人座机 |
email optional,string | 电子邮箱 |
province optional,string | 省份 ID |
city optional,string | 城市 ID |
country optional,string | 区县 ID |
终端信息 term_info 字段说明
参数 | 说明 |
---|
type optional,string | 终端类型 |
ip optional,string | 终端 IP |
mac optional,string | 终端 MAC |
imei optional,string | 终端 IMEI |
idfv optional,string | 终端 IDFV |
adid optional,string | 终端 ADID |
os optional,string | 操作系统 |
os_version optional,string | 操作系统版本 |
term_info_id optional,string | 终端号 |
pay_list 参数说明
参数 | 说明 |
---|
payType response-only,int | 支付方式。0:银行卡,1:打白条(不分期),2:余额,3:优惠券,5:小金库,6:网关,8:白条分期,9:白条支付(不分期)。 |
amount response-only,int | 交易金额,单位为分。 |
currency response-only,string | 交易币种,人民币为 CNY 。 |
tradeTime response-only,string | 交易时间,格式为 yyyyMMddHHmmss 。 |
detail optional,hash | 支付明细信息,具体参考下表 detail 参数说明 。 |
detail 参数 | 说明 |
---|
cardHolderName optional,string | 持卡人姓名,掩码显示。(支付方式为银行卡时返回) |
cardHolderMobile optional,string | 持卡人手机号,掩码显示。(支付方式为银行卡时返回) |
cardHolderType optional,string | 证件类型。0:身份证,1:护照,2:军官证,3:士兵证,4:港奥台通行证,5:临时身份证,6:户口本,7:其它类型证件。(支付方式为银行卡时返回) |
cardHolderId optional,string | 身份证号,掩码显示。(支付方式为银行卡时返回) |
cardNo optional,string | 卡号,掩码显示。(支付方式为银行卡时返回) |
bankCode optional,string | 银行编码。(支付方式为银行卡时返回) |
cardType optional,string | 银行卡类型。1:借记卡,2:信用卡。(支付方式为银行卡时返回) |
payMoney optional,string | 交易金额,单位为分。 |
注: 对于 user_type
, user_id
参数,传参存在问题请参考 帮助中心。
cmb_wallet(招行一网通)
extra 参数 | 说明 |
---|
app_pay optional,boolean | 是否使用招商银行 App 客户端支付,默认为 false 不使用。注:仅适用于 APP 集成招行一网通支付,H5 支付需传 "false" |
result_url required string | 支付完成的前端回调地址。使用招商银行 App 时,此处可传入 <SCHEME>://pingppcmbwallet ,其中 <SCHEME> 是你自定义的 URL Schemes ,用以支付完成后返回你的 App。 |
p_no optional,string | 客户协议号,不超过 30 位的纯数字字符串。未签约(首次支付)客户,填写新协议号,并传入 seq 参数,用于协议开通。商户必须对协议号进行管理,确保客户与协议号一一对应。 |
seq optional,string | 协议开通请求流水号,不超过 20 位的纯数字字符串,请保证系统内唯一。当用户首次支付即 p_no 是未签约的新协议号时,此参数必填。 |
m_uid optional,string | 协议用户 ID,不超过 20 位的纯数字字符串。 |
mobile optional,string | 协议手机号,11 位数字。 |
address_city optional,string | 订单收货城市,六位行政区划代码,详情请参考 全国行政区划代码表 |
address_mobile optional,string | 完整手机号或手机号后 4 位 |
product_type optional,string | 商品类型。由商户自定义,支持字母和数字 |
discount_amount response-only int | 立减金额。仅在支付完成时返回,单位为分 |
注: 对于 p_no、seq、m_uid、mobile
这几个参数:
- 这几个参数是用户自定义的;
对于同一个终端用户每次请求 Charge
时务必使用同一套参数(确保每个参数都不变),任意参数变更都会导致用户重新签约,同一个用户和招行重新签约的次数有限制,超限制就会无法签约 ,导致用户无法使用。
cmb_pc_qr(招行 PC 扫码支付)
extra 参数 | 说明 |
---|
result_url required string | 支付完成的前端回调地址。回调 HTTP 方法为 POST |
p_no optional string | 客户协议号。支持的字符集:数字、大小写字母、 -_ 两个特殊字符(英文半角)。未签约(首次支付)客户,填写新协议号,并传入 seq 参数,用于协议开通。商户必须对协议号进行管理,确保客户与协议号一一对应。 |
seq optional,string | 协议开通请求流水号,不超过 20 位的纯数字字符串,请保证系统内唯一必传。当用户首次支付即 p_no 是未签约的新协议号时,此参数必填。 |
m_uid optional,string | 商户系统内用户唯一标识。用于标识商户用户的唯一 ID,不超过 20 位的数字字母组合,建议使用纯数字。 |
mobile optional,string | 商户用户的手机号。 |
register_time optional,int | 商户用户注册 ID 的注册时间。 |
new_register optional,boolean | 是否是 24 小时内注册的 ID。可选值:true、false。 |
city_code optional,string | 粗略地理位置,六位行政区划代码,详情请参考 全国行政区划代码表。 |
address_city optional,string | 订单收货城市,六位行政区划代码,详情请参考 全国行政区划代码表。 |
address_mobile optional,string | 完整手机号或手机号后 4 位。 |
product_type optional,string | 商品类型。由商户自定义,支持字母和数字。 |
card_type response-only string | 支付卡类型。可选值:"02"-一卡通;"03"-信用卡;"07"-他行卡。 |
discount_amount response-only int | 立减金额。仅在支付完成时返回,单位为分 |
注: 对于 p_no、seq、m_uid、mobile
这几个参数:
- 这几个参数是用户自定义的;
- 对于同一个终端用户每次请求
Charge
时务必使用同一套参数(确保每个参数都不变),任意参数变更都会导致用户重新签约,同一个用户和招行重新签约的次数有限制,超限制就会无法签约 ,导致用户无法使用。
bfb_wap(百度钱包)
extra 参数 | 说明 |
---|
result_url required string | 支付完成的回调地址。 |
bfb_login required boolean | 是否需要登录百度钱包来进行支付。 |
yeepay_wap(易宝支付)
extra 参数 | 说明 |
---|
product_category required string | 商品类别码,详见 易宝支付商品类型码。 |
identity_id required string | 用户标识,商户生成的用户账号唯一标识,最长 50 位字符串。 |
identity_type required int | 用户标识类型,详见 易宝支付用户标识类型码。 |
terminal_type required int | 终端类型,对应取值 0:IMEI, 1:MAC, 2:UUID, 3:other。 |
terminal_id required string | 终端 ID。 |
user_ua required string | 用户使用的移动终端的 UserAgent 信息。 |
result_url required string | 前台通知地址。 |
isv_qr(线下扫码(主扫))
extra 参数 | 说明 |
---|
pay_channel required string | 具体支付渠道,支持:alipay 、wx 。 |
terminal_id conditional string | 上送您系统维护的终端序列号,要求不同终端此号码不一样,会显示在对账单中,固定 8 位。如没有终端概念,可使用00000001 。使用畅捷渠道时不需要,可选。 |
goods_list optional,string | 商品列表,详情请参考:goods_list 参数说明。 |
limit_pay conditional,string | 限定支付方式。不能使用信用卡支付可设置为no_credit 。使用畅捷渠道时不可用。 |
channel_discount response-only,int | 渠道优惠金额,支付完成的返回参数,单位为分。 |
merchant_discount response-only,int | 商户优惠金额,支付完成的返回参数,单位为分。 |
buyer_account response-only,string | 渠道账号,支付完成的返回参数。 |
buyer_user_id response-only,string | 渠道账号 ID,支付完成的返回参数。 |
ebank_pay_method response-only,hash | 支付信息。例:{"bank_card_type":"GC","bank_code":"ALIPAY","biz_type":"C"} 。使用畅捷扫码渠道时返回。 |
goods_list 参数说明
参数 | 类型 | 是否必须 | 描述 | 示例 |
---|
goods_name | string | required | 商品名称 | iphone6s16G |
price | string | required | 单价(单位:分) | 1001 |
goods_num | string | required | 数量 | 1 |
goods_id | string | required | 商户定义商品编号(一般商品条码) | iphone6s16G |
unified_goods_id | string | optional | 统一商品编号 | 1001 |
goods_category | string | optional | 商品类目 | 123456 |
body | string | optional | 商品描述信息 | 苹果手机16G |
show_url | string | optional | 商品的展示网址 | https://www.pingxx.com |
isv_scan(线下扫码(被扫))
extra 参数 | 说明 |
---|
scan_code required string | 支付宝、微信客户端付款条形码的数值,由扫码设备扫描获取。 |
terminal_id conditional string | 上送您系统维护的终端序列号,要求不同终端此号码不一样,会显示在对账单中,固定 8 位。如没有终端概念,可使用00000001 。使用畅捷扫码渠道时不需要,可选。 |
goods_list optional,string | 商品列表,详情请参考:goods_list 参数说明。 |
limit_pay conditional,string | 限定支付方式。不能使用信用卡支付可设置为no_credit 。使用畅捷扫码渠道时不可用。 |
pay_channel response-only,string | 用户支付渠道,支付完成的返回参数。 |
channel_discount response-only,int | 渠道优惠金额,支付完成的返回参数,单位为分。 |
merchant_discount response-only,int | 商户优惠金额,支付完成的返回参数,单位为分。 |
buyer_account response-only,string | 渠道账号,支付完成的返回参数。 |
buyer_user_id response-only,string | 渠道账号 ID,支付完成的返回参数。 |
goods_list 参数说明
参数 | 类型 | 是否必须 | 描述 | 示例 |
---|
goods_name | string | required | 商品名称 | iphone6s16G |
price | string | required | 单价(单位:分) | 1001 |
goods_num | string | required | 数量 | 1 |
goods_id | string | required | 商户定义商品编号(一般商品条码) | iphone6s16G |
unified_goods_id | string | optional | 统一商品编号 | 1001 |
goods_category | string | optional | 商品类目 | 123456 |
body | string | optional | 商品描述信息 | 苹果手机16G |
show_url | string | optional | 商品的展示网址 | https://www.pingxx.com |
isv_wap(线下扫码(固定码))
extra 参数 | 说明 |
---|
pay_channel required string | 具体支付渠道,支持:alipay 、wx 。(使用畅捷渠道时不支持 alipay) |
result_url required string | 前端通知地址。支付成功或失败后,需要跳转到的地址 URL。回调 HTTP 方法为 GET |
terminal_id conditional string | 上送您系统维护的终端序列号,要求不同终端此号码不一样,会显示在对账单中,固定 8 位。如没有终端概念,可使用00000001 。(使用畅捷渠道时,此参数可选) |
goods_list optional,string | 商品列表,详情请参考:goods_list 参数说明。 |
limit_pay optional,string | 限定支付方式。不能使用信用卡支付可设置为no_credit 。 |
goods_list 参数说明
参数 | 类型 | 是否必须 | 描述 | 示例 |
---|
goods_name | string | required | 商品名称 | iphone6s16G |
price | string | required | 单价(单位:分) | 1001 |
goods_num | string | required | 数量 | 1 |
goods_id | string | required | 商户定义商品编号(一般商品条码) | iphone6s16G |
unified_goods_id | string | optional | 统一商品编号 | 1001 |
goods_category | string | optional | 商品类目 | 123456 |
body | string | optional | 商品描述信息 | 苹果手机16G |
show_url | string | optional | 商品的展示网址 | https://www.pingxx.com |
isv_lite(线下小程序支付)
参数 | 描述 |
---|
open_id required string | 用户在商户 appid 下的唯一标识。点此参考 如何获取 open_id 。 |
terminal_id optional,string | 上送您系统维护的终端序列号,要求不同终端此号码不一样。 |
limit_pay optional,string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit 。 |
ccb_pay(建行 App 支付)
extra 参数 | 说明 |
---|
pos_id required string | 建行分配商户的柜台号 |
support_account_type optional,string | 支持的账户类别。1:信用卡;2:储蓄卡;3:全部;默认为 3:全部 |
remark optional,string | 备注信息(中文长度按3字节计算) , 建议不要包含特殊字符以及空格 |
in_offical_app optional,boolean | 使用建行应用内支付;false :商户 APP 跳转至建行 APP 支付。默认为true |
third_app_info conditional string | 返回按钮需跳回应用的 scheme 地址,当 in_offical_app 为 false 时必传。只支持以字母开头:字母+数字+- 符号 |
buyer_account response-only, string | 买家支付账号,仅在支付成功后返回 |
ccb_qr(建行二维码支付)
extra 参数 | 说明 |
---|
pos_id required string | 建行分配商户的柜台号 |
remark optional,string | 备注信息(中文长度按3字节计算) , 建议不要包含特殊字符以及空格 |
return_type optional, string | 返回类型。0 或null :返回二维码;1 :返回 json |
buyer_account response-only, string | 买家支付账号,仅在支付成功后返回 |
cmpay(移动和包支付)
extra 请求参数(请求参数都会显示在返回参数中)
参数 | 类型 | 长度 | 是否必须 | 描述 |
---|
user_token | string | [1~64] | required | 用户标识:待支付的手机号或者手机支付账户昵称 |
result_url | string | [1~256] | optional | 页面返回 URL,在通知交易结果时返回 |
show_url | string | [1~400] | optional | 商品展示地址,商品展示的 URL |
product_id | string | [1~50] | optional | 商品编号 |
product_num | string | [1-99999] | optional | 商品数量 |
coupon_flag | string | [1~10] | optional | 营销工具使用控制,具体取值见下表 |
merchant_abbr | string | [1-25] | optional | 商户展示名称(目前渠道暂时没有地方展示) |
coupon_flag 枚举值列表
- 00 使用全部营销工具(默认)
- 10 不支持使用红包
- 20 不支持代金券
- 30 不支持积分
- 40 不支持所有营销工具
- 变更为控制状态字:
- 第 1 位:电子券
- 第 2 位:代金券
- 第 3 位:积分
- 第 4 位:订单直减
- 第 5 位:现金(固定传 1) 其余位保留
- 0 为不支持,1 为支持,默认取 1111111111
extra 返回参数(包含以上请求参数)
参数 | 类型 | 是否必须 | 描述 |
---|
bank_abbr | string | optional | 支付银行,具体取值见下方银行代码对照表 |
bank_abbr 银行代码对照表
银行代码 | 银行名称 |
---|
ICBC | 工商银行 |
HSB | 徽商银行 |
CMB | 招商银行 |
HUNRCU | 湖南农村信用社 |
CCB | 建设银行 |
JJB | 九江银行 |
ABC | 农业银行 |
JSB | 江苏银行 |
BOC | 中国银行 |
NBB | 宁波银行 |
SPDB | 上海浦东发展银行 |
NXB | 宁夏银行 |
BCOM | 交通银行 |
QLB | 齐鲁银行 |
CMBC | 民生银行 |
QSB | 齐商银行 |
CEBB | 光大银行 |
RZB | 日照银行 |
GDB | 广东发展银行 |
SCB | 渣打银行 |
ECITIC | 中信银行 |
SDRCB | 顺德农村商业银行 |
HXB | 华夏银行 |
SHRCB | 上海农村商业银行 |
CIB | 兴业银行 |
SJB | 盛京银行 |
PSBC | 邮政储蓄银行 |
SPABANK | 平安银行 |
SDB | 深圳发展银行 |
SRB | 上饶银行 |
BBGB | 广西北部湾银行 |
SZB | 苏州银行 |
BEA | 东亚银行 |
SZRCB | 深圳农村商业银行 |
CBHB | 渤海银行 |
TACCB | 泰安市商业银行 |
CDRCB | 成都农村商业银行 |
WHCCB | 威海市商业银行 |
CQRCB | 重庆农村商业银行 |
WLMQCCB | 乌鲁木齐市商业银行 |
DGB | 东莞银行 |
WZB | 温州银行 |
DLB | 大连银行 |
XMB | 厦门银行 |
DYCCB | 东营市商业银行 |
YCCCB | 宜昌市商业银行 |
FDB | 富滇银行 |
ZHRCU | 珠海市农村信用合作社 |
GZB | 广州银行 |
ZJCCB | 浙商银行 |
HBB | 河北银行 |
ZJGRCB | 张家港农商银行 |
HKB | 汉口银行 |
NCB | 南洋商业银行 |
HZB | 杭州银行 |
SHRCB | 上海农村商业银行 |
LTCCB | 浙江泰隆商业银行 |
CBHB | 渤海银行 |
HSB | 徽商银行 |
NJCB | 南京银行 |
BJRCB | 北京农商银行 |
BOB | 北京银行 |
coolcredit(库分期)
extra 请求参数(请求参数都会显示在返回参数中)
参数 | 说明 |
---|
uid required string | 用户在商户侧的唯一 ID |
stage_num required int | 分期数。只允许 [1、3、6、12],对应的是:不分期、3期、6期、12期 |
result_url required string | 回调访问地址 |
device_type required int | 风控参数,设备类型。只允许 [10、21、22、90]。10:PC,21:iOS,22:Android,90:其他 |
mac optional,string | 风控参数,设备 mac 地址,pc 端、android 端提供 |
imei optional,string | 风控参数,IMEI,安卓端提供 |
uuid optional,string | 风控参数,ios 唯一标识 |
ssid optional,string | 风控参数,无线网络 |
cb_alipay(跨境支付宝 App 支付)
extra 参数 | 说明 |
---|
refer_url required string | 公司网站首页(如果没有,则是 APP 下载地址) |
trade_information required hash | 传递商品信息。详见下方的 trade_information 字段说明 |
payment_type optional, string | 支付类型。默认值为:1(商品购买) |
split_fund_info optional, array | 分账列表,上送格式为: [{"account": "2088866088886666","amount": 1,"desc": "split_desc desc"}] ,详情参考下方 split_fund_info参数说明 |
settle_currency optional, string | 实际结算的外币币种,当 currency =cny (使用人民币标价)时该参数必填 |
pay_amount response-only, int | 原订单的人民币金额,仅在支付成功后返回 |
buyer_account response-only, string | 买家支付宝账号,仅在支付成功后返回 |
buyer_id response-only, string | 买家在支付宝的用户 ID,仅在支付成功后返回 |
rate response-only, float | 汇率,仅在支付成功后返回 |
trade_information 参数说明
参数 | 描述 |
---|
business_type required string | 用于表示该笔订单商品的类型。1:酒店行业、2:民航运输业、3:留学产业、4:商品零售业、5:其他。多个可用| 分隔。示例:1|2|3|4|5 或 1 |
hotel_name conditional,string | 当 business_type 为 1 时需要,用于表示酒店名称。多个可用| 分隔。示例:zlidu, sluhg-987, 889utng |
check_in_time conditional,string | 当 business_type 为 1 时需要,用于表示入住时间。示例:2018-10-20 |
check_out_time conditional,string | 当 business_type 为 1 时需要,用于表示离店时间。示例:2018-10-22 |
flight_number conditional,string | 当 business_type 为 2 时需要,用于表示航班号。多个可用| 分隔。示例:NWS 996|TWF 8854 |
departure_time conditional,string | 当 business_type 为 2 时需要,用于表示起飞时间。多个可用| 分隔。示例:2018-10-22 20:49 |
admission_notice_url conditional,string | 当 business_type 为 3 时需要,用于表示录取通知书的图片链接。示例:https://www.iconfont.cn/search/index?test |
goods_info conditional,string | 当 business_type 为 4 时需要,用于表示零售商品信息。格式:name^number 。多个可用| 分隔。示例:pencil^2|eraser^5|iPhone XS 256G^1 |
total_quantity conditional,string | 当 business_type 为 4 时需要,用于表示goods_info中商品的总数量。示例:8 |
other_business_type conditional,string | 当 business_type 为 5 时需要,用于表示商品类型。示例:Airport pick up service |
split_fund_info 参数说明
参数 | 说明 |
---|
account required, string | 接受分账资金的支付宝账户ID |
amount required, string | 分账的金额 |
desc optional, string | 分账描述信息 |
cb_alipay_wap(跨境支付宝手机网站支付)
extra 参数 | 说明 |
---|
refer_url required string | 公司网站首页(如果没有,则是 APP 下载地址) |
trade_information required hash | 传递商品信息。详见下方的 trade_information 字段说明 |
success_url optional, string | 交易付款成功之后,返回到商家网站的 URL |
app_pay optional, boolean | 是否唤起支付宝钱包来进行支付。如果支付宝钱包没有安装,则使用 wap 方式支付 |
supplier_name optional, string | 供货商名字 |
split_fund_info optional, array | 分账列表,上送格式为: [{"account": "2088866088886666","amount": 1,"desc": "split_desc desc"}] ,详情参考下方 split_fund_info参数说明 |
settle_currency optional, string | 实际结算的外币币种,当 currency =cny (使用人民币标价)时该参数必填 |
pay_amount response-only, int | 原订单的人民币金额,仅在支付成功后返回 |
buyer_account response-only, string | 买家支付宝账号,仅在支付成功后返回 |
buyer_id response-only, string | 买家在支付宝的用户 ID,仅在支付成功后返回 |
rate response-only, float | 汇率,仅在支付成功后返回 |
trade_information 参数说明
参数 | 描述 |
---|
business_type required string | 用于表示该笔订单商品的类型。1:酒店行业、2:民航运输业、3:留学产业、4:商品零售业、5:其他。多个可用| 分隔。示例:1|2|3|4|5 或 1 |
hotel_name conditional,string | 当 business_type 为 1 时需要,用于表示酒店名称。多个可用| 分隔。示例:zlidu, sluhg-987, 889utng |
check_in_time conditional,string | 当 business_type 为 1 时需要,用于表示入住时间。示例:2018-10-20 |
check_out_time conditional,string | 当 business_type 为 1 时需要,用于表示离店时间。示例:2018-10-22 |
flight_number conditional,string | 当 business_type 为 2 时需要,用于表示航班号。多个可用| 分隔。示例:NWS 996|TWF 8854 |
departure_time conditional,string | 当 business_type 为 2 时需要,用于表示起飞时间。多个可用| 分隔。示例:2018-10-22 20:49 |
admission_notice_url conditional,string | 当 business_type 为 3 时需要,用于表示录取通知书的图片链接。示例:https://www.iconfont.cn/search/index?test |
goods_info conditional,string | 当 business_type 为 4 时需要,用于表示零售商品信息。格式:name^number 。多个可用| 分隔。示例:pencil^2|eraser^5|iPhone XS 256G^1 |
total_quantity conditional,string | 当 business_type 为 4 时需要,用于表示goods_info中商品的总数量。示例:8 |
other_business_type conditional,string | 当 business_type 为 5 时需要,用于表示商品类型。示例:Airport pick up service |
split_fund_info 参数说明
参数 | 说明 |
---|
account required, string | 接受分账资金的支付宝账户ID |
amount required, string | 分账的金额 |
desc optional, string | 分账描述信息 |
cb_alipay_qr(跨境支付宝扫码支付)
extra 参数 | 说明 |
---|
quantity optional, int | 商品数量 |
price optional, int | 商品价格 |
goods_list optional, list | 订单包含的商品列表信息(json字符串的长度为1~8000),详情请参考:goods_list 参数说明 |
show_url optional, string | 商品的展示地址 |
sys_service_provider_id optional, string | 系统商编号 |
pay_amount response-only, int | 原订单的人民币金额,仅在支付成功后返回 |
buyer_account response-only, string | 买家支付宝账号,仅在支付成功后返回 |
buyer_user_id response-only, string | 买家在支付宝的用户 ID,仅在支付成功后返回 |
rate response-only, float | 汇率,仅在支付成功后返回 |
goods_list 参数说明
注:同时使用了 price 和 quantity 参数时,charge.amount 必须等于 price * quantity 的总和
参数 | 类型 | 范围 | 是否必需 | 默认值 | 说明 |
---|
goods_id | string | 1 ~ 32 | required | 无 | 商品的编号 |
goods_name | string | 1 ~ 256 | required | 无 | 商品名称 |
quantity | integer | 1 ~ 10 | required | 无 | 商品数量 |
price | string | 1 ~ 9 | required | 无 | 商品单价,单位为元 |
goods_category | string | 1 ~ 24 | optional | 无 | 商品类目 |
body | string | 1 ~ 1000 | optional | 无 | 商品描述信息 |
show_url | string | 1 ~ 400 | optional | 无 | 商品的展示地址 |
cb_alipay_scan(跨境支付宝条码支付)
extra 参数 | 说明 |
---|
scan_code REQUIRED string | 支付宝客户端付款码条码,以 25~30 开头,16~24 为长度的数字 |
terminal_id optional, string | 终端ID (超过64位长度请联系支付宝客服) |
quantity optional, int | 商品数量 |
sys_service_provider_id optional, string | 系统商编号 |
pay_amount response-only, int | 原订单的人民币金额,仅在支付成功后返回 |
buyer_account response-only, string | 买家支付宝账号,仅在支付成功后返回 |
buyer_user_id response-only, string | 买家在支付宝的用户 ID,仅在支付成功后返回 |
rate response-only, float | 汇率,仅在支付成功后返回 |
cb_alipay_pc_direct(跨境支付宝电脑网站支付)
extra 参数 | 说明 |
---|
refer_url required string | 公司网站首页(如果没有,则是 APP 下载地址) |
trade_information required hash | 传递商品信息。详见下方的 trade_information 字段说明 |
success_url optional, string | 交易付款成功之后,返回到商家网站的 URL |
split_fund_info optional, array | 分账列表,上送格式为: [{"account": "2088866088886666","amount": 1,"desc": "split_desc desc"}] ,详情参考下方 split_fund_info参数说明 |
settle_currency optional, string | 实际结算的外币币种,当 currency =cny (使用人民币标价)时该参数必填 |
pay_amount response-only, int | 原订单的人民币金额,仅在支付成功后返回 |
buyer_account response-only, string | 买家支付宝账号,仅在支付成功后返回 |
buyer_user_id response-only, string | 买家在支付宝的用户 ID,仅在支付成功后返回 |
rate response-only, float | 汇率,仅在支付成功后返回 |
trade_information 参数说明
参数 | 描述 |
---|
business_type required string | 用于表示该笔订单商品的类型。1:酒店行业、2:民航运输业、3:留学产业、4:商品零售业、5:其他。多个可用| 分隔。示例:1|2|3|4|5 或 1 |
hotel_name conditional,string | 当 business_type 为 1 时需要,用于表示酒店名称。多个可用| 分隔。示例:zlidu, sluhg-987, 889utng |
check_in_time conditional,string | 当 business_type 为 1 时需要,用于表示入住时间。示例:2018-10-20 |
check_out_time conditional,string | 当 business_type 为 1 时需要,用于表示离店时间。示例:2018-10-22 |
flight_number conditional,string | 当 business_type 为 2 时需要,用于表示航班号。多个可用| 分隔。示例:NWS 996|TWF 8854 |
departure_time conditional,string | 当 business_type 为 2 时需要,用于表示起飞时间。多个可用| 分隔。示例:2018-10-22 20:49 |
admission_notice_url conditional,string | 当 business_type 为 3 时需要,用于表示录取通知书的图片链接。示例:https://www.iconfont.cn/search/index?test |
goods_info conditional,string | 当 business_type 为 4 时需要,用于表示零售商品信息。格式:name^number 。多个可用| 分隔。示例:pencil^2|eraser^5|iPhone XS 256G^1 |
total_quantity conditional,string | 当 business_type 为 4 时需要,用于表示goods_info中商品的总数量。示例:8 |
other_business_type conditional,string | 当 business_type 为 5 时需要,用于表示商品类型。示例:Airport pick up service |
split_fund_info 参数说明
参数 | 说明 |
---|
account required, string | 接受分账资金的支付宝账户ID |
amount required, string | 分账的金额 |
desc optional, string | 分账描述信息 |
cb_wx(跨境微信 App 支付)
extra 参数 | 说明 |
---|
goods_listoptional | 商品列表,上送格式为: [{"goods_name":"iPhone6s 16G","goods_num":"1"},{"goods_name":"iPhone6s 32G","goods_num":"1"}] ,字段解释:goods_name:商品名称;goods_num:数量 |
limit_pay optional, string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit |
is_subscribe response-only, string | 支付成功后额外返回用户是否关注公众账号,仅在公众账号类型支付有效,取值范围:Y 或 N;Y-关注;N-未关注 |
bank_type response-only, string | 支付成功后额外返回银行类型,采用字符串类型的银行标识 |
cash_fee response-only, string | 支付成功后额外返回现金支付金额 |
cash_fee_type response-only, string | 支付成功后额外返回现金支付币种,符合ISO 4217标准的三位字母代码 |
rate response-only, string | 支付成功后额外返回汇率,标价币种与支付币种的兑换比例乘以10的8次方即为此值,例如美元兑换人民币的比例为6.5,则rate=650000000 |
cb_wx_pub(跨境微信 JSAPI 支付)
extra 参数 | 说明 |
---|
open_id required string | 用户在商户 appid 下的唯一标识 |
goods_list required array | 商品列表,上送格式见下方的 goods_list 字段说明 |
limit_pay optional, string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit |
is_subscribe response-only, string | 支付成功后额外返回用户是否关注公众账号,仅在公众账号类型支付有效,取值范围:Y 或 N;Y-关注;N-未关注 |
bank_type response-only, string | 支付成功后额外返回银行类型,采用字符串类型的银行标识 |
cash_fee response-only, int | 支付成功后额外返回现金支付金额 |
cash_fee_type response-only, string | 支付成功后额外返回现金支付币种,符合ISO 4217标准的三位字母代码 |
rate response-only, string | 支付成功后额外返回汇率,标价币种与支付币种的兑换比例乘以10的8次方即为此值,例如美元兑换人民币的比例为6.5,则rate=650000000 |
goods_list 字段说明
参数 | 描述 |
---|
goods_id conditional,string | 商品编码。使用香港微信跨境时必传 |
goods_name required string | 商品名称 |
goods_num required string | 商品数量 |
price conditional,int | 商品单价。使用香港微信跨境时必传 |
wxpay_goods_id optional,string | 微信侧商品编码(没有可以不传) |
cb_wx_pub_qr(跨境微信 Native 支付)
extra 参数 | 说明 |
---|
product_id required string | 商品 ID,1-32 位字符串。此 id 为二维码中包含的商品 ID,商户自行维护 |
goods_list required array | 商品列表,上送格式见下方的 goods_list 字段说明 |
limit_pay optional, string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit |
is_subscribe response-only, string | 支付成功后额外返回用户是否关注公众账号,仅在公众账号类型支付有效,取值范围:Y 或 N;Y-关注;N-未关注 |
bank_type response-only, string | 支付成功后额外返回银行类型,采用字符串类型的银行标识 |
cash_fee response-only, int | 支付成功后额外返回现金支付金额 |
cash_fee_type response-only, string | 支付成功后额外返回现金支付币种,符合ISO 4217标准的三位字母代码 |
rate response-only, string | 支付成功后额外返回汇率,标价币种与支付币种的兑换比例乘以10的8次方即为此值,例如美元兑换人民币的比例为6.5,则rate=650000000 |
goods_list 字段说明
参数 | 描述 |
---|
goods_id conditional,string | 商品编码。使用香港微信跨境时必传 |
goods_name required string | 商品名称 |
goods_num required string | 商品数量 |
price conditional,int | 商品单价。使用香港微信跨境时必传 |
wxpay_goods_id optional,string | 微信侧商品编码(没有可以不传) |
cb_wx_pub_scan(跨境微信付款码支付)
extra 参数 | 说明 |
---|
scan_code required string | 微信客户端付款条形码的数值,由扫码设备扫描获取。 |
goods_list required string | 商品列表,上送格式为: [{"goods_name":"iPhone6s 16G","goods_num":"1"},{"goods_name":"iPhone6s 32G","goods_num":"1"}] ,字段解释:goods_name:商品名称;goods_num:数量 |
terminal_id optional, string | 终端号,要求不同终端此号码不一样,如A01、SH008等 |
limit_pay optional, string | 指定支付方式,指定不能使用信用卡支付可设置为 no_credit |
open_id response-only, string | 支付成功后额外返回用户在商户 app 下的唯一标识(此标识只有在配置渠道参数里面配置了 appid (如果是服务商情景就是子商户的)渠道才会返回) |
is_subscribe response-only, string | 支付成功后额外返回用户是否关注公众账号,仅在公众账号类型支付有效,取值范围:Y 或 N;Y-关注;N-未关注 |
bank_type response-only, string | 支付成功后额外返回银行类型,采用字符串类型的银行标识 |
cash_fee response-only, int | 支付成功后额外返回现金支付金额 |
cash_fee_type response-only, string | 支付成功后额外返回现金支付币种,符合ISO 4217标准的三位字母代码 |
rate response-only, string | 支付成功后额外返回汇率,标价币种与支付币种的兑换比例乘以10的8次方即为此值,例如美元兑换人民币的比例为6.5,则rate=650000000 |
paypal(PayPal 支付)
extra 参数 | 类型 | 是否必须 | 描述 |
---|
result_url | string | required | 支付成功或失败时的跳转 url |
cancel_url | string | required | 支付取消时的跳转 url |
purchase_order | string | optional | 采购单号 |
transaction_detail | hash | optional | 交易明细,详情参考下方 transaction_detail 参数说明 |
goods_list | list | optional | 商品列表,详情参考下方 goods_list 参数说明 |
shipping_detail | hash | optional | 快递地址信息,详情参考下方 shipping_detail 参数说明 |
payment_id | string | response-only | PayPal payment 对象 ID,在创建 Charge 后返回 |
payer | hash | response-only | 付款用户信息,在支付完成后返回 |
payee | hash | response-only | 商户信息,在支付完成后返回 |
transaction_detail 参数说明
参数 | 类型 | 是否必须 | 描述 |
---|
amount | int | optional | 订单金额 |
tax | int | optional | 税费 |
shipping | int | optional | 运输费 |
handling_fee | int | optional | 手续费 |
shipping_discount | int | optional | 运费折扣 |
insurance | int | optional | 保险费 |
gift_wrap | int | optional | 礼品包装费 |
goods_list 参数说明
参数 | 类型 | 是否必须 | 描述 |
---|
name | string | optinal | 商品名称 |
description | string | optional | 商品描述信息 |
quantity | string | optional | 商品数量 |
price | int | optional | 商品金额 |
tax | int | optional | 商品税费 |
sku | string | optional | 商品SKU ID |
shipping_detail 参数说明
参数 | 类型 | 是否必须 | 描述 |
---|
shipping_method | string | optinal | 快递方式 例如 USPS |
recipient_name | string | optional | 收货人 |
line1 | string | optional | 地址一 |
line2 | string | optional | 地址二 |
city | string | optional | 城市 |
country_code | string | optional | 城市代码 |
postal_code | string | optional | 邮编 |
phone | string | optional | 手机号 |
state | string | optional | 州代码 state-codes |
balance(余额支付)
extra 参数 | 说明 |
---|
user required string | 使用余额支付所对应的用户 user id 。注:在创建 Order 时,若后续需要使用 balance 渠道进行支付,则创建 Order 时的参数 uid 必传,执行 Order Pay 方法时此处 user 参数无需传;在创建 Charge 时,若后续需要使用 balance 渠道进行支付,此处 user 参数必传。 |
yeepay_alipay_lite(易宝-支付宝小程序支付)
extra 参数 | 说明 |
---|
buyer_user_id required string | 支付宝用户 ID |
yeepay_alipay_qr(易宝-支付宝扫码支付)
注: 支付请求响应的地址需要平台讲链接转换为二维码显示,用户使用支付宝扫一扫,扫描二维码发起支付
yeepay_alipay_pub(易宝-支付宝生活号支付)
extra 参数 | 说明 |
---|
buyer_user_id required string | 支付宝用户 ID |
yeepay_alipay_scan(易宝-支付宝条码支付)
extra 参数 | 说明 |
---|
terminal_id required string | 终端 ID |
scan_code required string | 支付宝条码值 |
yeepay_wx_pub_qr(易宝-微信Native)
extra 参数 | 说明 |
---|
terminal_id required string | 终端 ID |
yeepay_wx_pub(易宝-微信公众号支付)
extra 参数 | 说明 |
---|
open_id required string | 用户在商户 appid 下的唯一标识。点此参考 如何获取 open_id 。 |
wx_app_id required string | 微信 应用 ID |
terminal_id required string | 终端 ID |
yeepay_wx_pub_off(易宝-微信公众号支付(线下))
extra 参数 | 说明 |
---|
open_id required string | 用户在商户 appid 下的唯一标识。点此参考 如何获取 open_id 。 |
wx_app_id required string | 微信 应用 ID |
terminal_id required string | 终端 ID |
yeepay_wx_lite(易宝-微信小程序支付)
extra 参数 | 说明 |
---|
open_id required string | 用户在商户 appid 下的唯一标识。点此参考 如何获取 open_id 。 |
wx_app_id required string | 微信 应用 ID |
terminal_id required string | 终端 ID |
yeepay_wx_lite_off(易宝-微信小程序支付(线下))
extra 参数 | 说明 |
---|
open_id required string | 用户在商户 appid 下的唯一标识。点此参考 如何获取 open_id 。 |
wx_app_id required string | 微信 应用 ID |
terminal_id required string | 终端 ID |
yeepay_wx_pub_scan(易宝-微信付款码支付)
extra 参数 | 说明 |
---|
terminal_id required string | 终端 ID |
scan_code required string | 微信支付条码值 |
yeepay_upacp_qr(易宝-银联二维码(主扫)
extra 参数 | 说明 |
---|
terminal_id required string | 终端 ID |
yeepay_upacp_scan(易宝-银联二维码(被扫)
注: 终端 ID 参数要求: 长度必须为 8 位
产品系列标识符: SR 手刷等小终端;MP(MPOS),TP (传统 POS),P (智能 POS), QR (云闪付终端)
产品型号类别 用一位 1~9 的数字表示
产品主型号: 用一位 0~9 的数字表示
特殊配置: 用一位或多位字母和数字表示,例如: TP101001
extra 参数 | 说明 |
---|
terminal_id required string | 终端 ID |
scan_code required string | 云闪付支付条码值 |